Skip to content

[java][jaxrs-spec][quarkus] - PArt 3 - userecords#24188

Draft
Ignacio-Vidal wants to merge 1 commit into
OpenAPITools:masterfrom
Ignacio-Vidal:pr3-jaxrs-userecords
Draft

[java][jaxrs-spec][quarkus] - PArt 3 - userecords#24188
Ignacio-Vidal wants to merge 1 commit into
OpenAPITools:masterfrom
Ignacio-Vidal:pr3-jaxrs-userecords

Conversation

@Ignacio-Vidal

@Ignacio-Vidal Ignacio-Vidal commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Adds useOneOfInterfaces, useSealed, and useRecords to jaxrs-spec to generate oneOf interfaces, optional sealed hierarchies, and record implementations; updates discriminator mapping and accessor signatures so polymorphic serialization works and record outputs compile cleanly.

  • New Features

    • useOneOfInterfaces: oneOf schemas render as Java interfaces; subtypes implement them; interface carries typed discriminator getter and Jackson type annotations via oneof_interface template.
    • useSealed: marks the interface sealed and lists permitted subtypes; implementing classes become final; POM switches to Java 17.
    • useRecords: eligible implementors of a generated oneOf interface render as Java records (no parent, no additionalProperties); the interface declares the discriminator accessor in record style so records satisfy it; records are not forced final; POM switches to Java 17. Independent of useSealed.
    • Routing and templates updated (model.mustache, sealed/permits helpers, record.mustache); new sample/config (jaxrs-spec-records) added and included in the JDK17 samples workflow.
  • Bug Fixes

    • Resolve the discriminator property type and @JsonTypeName for subtypes from the oneOf interface’s mapped children when the parent is an interface, avoiding String fallback and ensuring correct enum types.
    • Tests added for interface-only, sealed, and record scenarios to verify mappings and method signatures.

Written for commit 940a93b. Summary will update on new commits.

Review in cubic

@Ignacio-Vidal Ignacio-Vidal changed the title Pr3 jaxrs userecords [java][jaxrs-spec][quarkus] - Pr3 jaxrs userecords Jul 2, 2026
@Ignacio-Vidal Ignacio-Vidal changed the title [java][jaxrs-spec][quarkus] - Pr3 jaxrs userecords [java][jaxrs-spec][quarkus] - PArt 3 - jaxrs userecords Jul 2, 2026
@Ignacio-Vidal Ignacio-Vidal changed the title [java][jaxrs-spec][quarkus] - PArt 3 - jaxrs userecords [java][jaxrs-spec][quarkus] - PArt 3 - userecords Jul 2, 2026
@Ignacio-Vidal Ignacio-Vidal force-pushed the pr3-jaxrs-userecords branch from db470ed to 98fdba1 Compare July 2, 2026 23:35
Adds a useRecords option to the jaxrs-spec generator. When useRecords=true, the
concrete subtypes that implement a generated oneOf interface render as Java
records instead of mutable classes.

- JavaJAXRSSpecServerCodegen: useRecords option, and postProcessAllModels marks
  record-eligible implementors with x-jaxrs-record (no parent, no additional
  properties, implements a generated oneOf interface).
- record.mustache renders the record; model.mustache routes x-jaxrs-record to it.
- oneof_interface.mustache declares the discriminator accessor in record style
  (petType()) under useRecords so records satisfy the interface via their
  canonical accessors; sealed.mustache no longer marks a record final.
- pom.mustache bumps java.version to 17 when useRecords (records need JDK 16+).
- Adds testOneOfRecordImplementationGeneration and a jaxrs-spec-records sample
  (registered in the JDK17 samples workflow).

useRecords is independent of useSealed. The feature stays opt-in; default
jaxrs-spec output is unchanged.
@Ignacio-Vidal Ignacio-Vidal force-pushed the pr3-jaxrs-userecords branch from 98fdba1 to 940a93b Compare July 10, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant